home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1997 #1 / Amiga Plus CD - 1997 - No. 01.iso / pd / programmierung / quickautodocks / dos.doc < prev    next >
Text File  |  1992-09-03  |  23KB  |  774 lines
  1. dos.library quick autodocs
  2.  
  3. NAME     : AbortPkt
  4. FUNCTION : Aborts an asynchronous packet, if possible
  5. SYNOPSIS : AbortPkt(port,pkt)
  6.              -264    D1   D2
  7.  
  8. NAME     : AddBuffers
  9. FUNCTION : Changes the number of buffers for a filesystem
  10. SYNOPSIS : success=AddBuffers(filesystem,number)
  11.              D0       -732        D1       D2
  12.  
  13. NAME     : AddDosEntry
  14. FUNCTION : Add a Dos List entry to the lists
  15. SYNOPSIS : success=AddDosEntry(dlist)
  16.               D0      -678      D1
  17.  
  18. NAME     : AddPart
  19. FUNCTION : Appends a file/dir to the end of a path
  20. SYNOPSIS : success=AddPart(dirname,filename,size)
  21.               D0    -882      D1      D2     D3
  22.  
  23. NAME     : AddSegment
  24. FUNCTION : Adds a resident segment to the resident list
  25. SYNOPSIS : success=AddSegment(name,seglist,type)
  26.               D0     -774      D1    D2     D3
  27.  
  28. NAME     : AllocDosObject
  29. FUNCTION : Creates a dos object
  30. SYNOPSIS : ptr=AllocDosObject(type,tags)
  31.            D0      -228        D1   D2
  32.  
  33. NAME     : AssignAdd
  34. FUNCTION : Adds a lock to an assign for multi-directory assigns
  35. SYNOPSIS : success=AssignAdd(name,lock)
  36.               D0     -630     D1   D2
  37.  
  38. NAME     : AssignLate
  39. FUNCTION : Creates an assignment to a specified path later
  40. SYNOPSIS : success=AssignLate(name,path)
  41.               D0     -618      D1   D2
  42.  
  43. NAME     : AssignLock
  44. FUNCTION : Creates an assignment to a locked object
  45. SYNOPSIS : success=AssignLock(name,lock)
  46.               D0      -612     D1   D2
  47.  
  48. NAME     : AssignPath
  49. FUNCTION : Creates an assignment to a specified path
  50. SYNOPSIS : success=AssignPath(name,path)
  51.               D0     -624      D1   D2
  52.  
  53. NAME     : AttemptLockDosList
  54. FUNCTION : Attempt to lock the Dos Lists for use
  55. SYNOPSIS : dlist=AttemptLockDosList(flags)
  56.              D0        -666          D1
  57.  
  58. NAME     : ChangeMode
  59. FUNCTION : Change the current mode of a lock or filehandle
  60. SYNOPSIS : success=ChangeMode(type,object,newmode)
  61.               D0      -450     D1    D2      D3
  62.  
  63. NAME     : CheckSignal
  64. FUNCTION : Checks for break signals
  65. SYNOPSIS : signals=CheckSignal(mask)
  66.              D0       -792      D1
  67.  
  68. NAME     : Cli
  69. FUNCTION : Returns a pointer to the CLI structure of the process
  70. SYNOPSIS : cli_ptr=Cli()
  71.               D0   -492
  72.  
  73. NAME     : CliInitNewcli
  74. FUNCTION : Set up a process to be a shell from initial packet
  75. SYNOPSIS : flags=CliInitNewcli(packet)
  76.              D0      -930        A0
  77.  
  78. NAME     : CliInitRun
  79. FUNCTION : Set up a process to be a shell from initial packet
  80. SYNOPSIS : flags=CliInitRun(packet)
  81.              D0     -936      A0
  82.  
  83. NAME     : Close
  84. FUNCTION : Close an open file
  85. SYNOPSIS : success=Close(file)
  86.               D0    -36   D1
  87.  
  88. NAME     : CompareDates
  89. FUNCTION : Compares two datestamps
  90. SYNOPSIS : result=CompareDates(date1,date2)
  91.              D0       -738       D1    D2
  92.  
  93. NAME     : CreateDir
  94. FUNCTION : Create a new directory
  95. SYNOPSIS : lock=CreateDir(name)
  96.             D0    -120     D1
  97.  
  98. NAME     : CreateNewProc
  99. FUNCTION : Create a new process
  100. SYNOPSIS : process=CreateNewProc(tags)
  101.               D0       -498       D1
  102.  
  103. NAME     : CreateProc
  104. FUNCTION : Create a new process
  105. SYNOPSIS : process=CreateProc(name,pri,seglist,stackSize)
  106.               D0      -138     D1  D2    D3       D4
  107.  
  108. NAME     : CurrentDir
  109. FUNCTION : Make a directory lock the current directory
  110. SYNOPSIS : oldLock=CurrentDir(lock)
  111.               D0      -126     D1
  112.  
  113. NAME     : DateStamp
  114. FUNCTION : Obtain the date and time in internal format
  115. SYNOPSIS : ds=DateStamp(ds)
  116.            D0   -192    D1
  117.  
  118. NAME     : DateToStr
  119. FUNCTION : Converts a DateStamp to a string
  120. SYNOPSIS : success=DateToStr(datetime)
  121.               D0     -744       D1
  122.  
  123. NAME     : Delay
  124. FUNCTION : Delay a process for a specified time
  125. SYNOPSIS : Delay(ticks)
  126.            -198    D1
  127.  
  128. NAME     : DeleteFile
  129. FUNCTION : Delete a file or directory
  130. SYNOPSIS : success=DeleteFile(name)
  131.              D0       -72      D1
  132.  
  133. NAME     : DeleteVar
  134. FUNCTION : Deletes a local or environment variable
  135. SYNOPSIS : success=DeleteVar(name,flags)
  136.              D0      -912     D1   D2
  137.  
  138. NAME     : DeviceProc
  139. FUNCTION : Return the process MsgPort of specific I/O handler
  140. SYNOPSIS : process=DeviceProc(name)
  141.               D0     -174      D1
  142.  
  143. NAME     : DoPkt
  144. FUNCTION : Send a dos packet and wait for reply
  145. SYNOPSIS : result1=DoPkt(port,action,arg1,arg2,arg3,arg4,arg5)
  146.              D0    -240   D1    D2    D3   D4   D5   D6   D7
  147.  
  148. NAME     : DupLock
  149. FUNCTION : Duplicate a lock
  150. SYNOPSIS : lock=DupLock(lock)
  151.             D0    -96    D1
  152.  
  153. NAME     : DupLockFromFH
  154. FUNCTION : Gets a lock on an open file
  155. SYNOPSIS : lock=DupLockFromFH(fh)
  156.             D0      -372      D1
  157.  
  158. NAME     : EndNotify
  159. FUNCTION : Ends a notification request
  160. SYNOPSIS : EndNotify(notifystructure)
  161.              -894           D1
  162.  
  163. NAME     : ErrorReport
  164. FUNCTION : Displays a Retry/Cancel requester for an error
  165. SYNOPSIS : status=ErrorReport(code,type,arg1,device)
  166.              D0      -480      D1   D2   D3    D4
  167.  
  168. NAME     : ExAll
  169. FUNCTION : Examine an entire directory
  170. SYNOPSIS : continue=ExAll(lock,buffer,size,type,control)
  171.               D0     -432  D1    D2    D3   D4     D5
  172.  
  173. NAME     : ExAllEnd
  174. FUNCTION : Stop an ExAll()
  175. SYNOPSIS : ExAllEnd(lock,buffer,size,type,control)
  176.              -990    D1    D2    D3   D4     D5
  177.  
  178. NAME     : Examine
  179. FUNCTION : Examine a directory or file associated with a lock
  180. SYNOPSIS : success=Examine(lock,FileInfoBlock)
  181.              D0     -102    D1        D2
  182.  
  183. NAME     : ExamineFH
  184. FUNCTION : Gets information on an open file
  185. SYNOPSIS : success=ExamineFH(fh,fib)
  186.              D0      -390    D1  D2
  187.  
  188. NAME     : Execute
  189. FUNCTION : Execute a CLI command
  190. SYNOPSIS : success=Execute(commandString,input,output)
  191.              D0     -222        D1         D2    D3
  192.  
  193. NAME     : Exit
  194. FUNCTION : Exit from a program
  195. SYNOPSIS : Exit(returnCode)
  196.            -144     D1
  197.  
  198. NAME     : ExNext
  199. FUNCTION : Examine the next entry in a directory
  200. SYNOPSIS : success=ExNext(lock,FileInfoBlock)
  201.              D0     -108   D1        D2
  202.  
  203. NAME     : Fault
  204. FUNCTION : Returns the text associated with a DOS error code
  205. SYNOPSIS : len=Fault(code,header,buffer,len)
  206.             D0  -468  D1    D2     D3    D4
  207.  
  208. NAME     : FGetC
  209. FUNCTION : Read a character from the specified input (buffered)
  210. SYNOPSIS : char=FGetC(fh)
  211.             D0   -306 D1
  212.  
  213. NAME     : FGets
  214. FUNCTION : Reads a line from the specified input (buffered)
  215. SYNOPSIS : buffer=FGets(fh,buf,len)
  216.              D0    -336 D1  D2  D3
  217.  
  218. NAME     : FilePart
  219. FUNCTION : Returns the last component of a path
  220. SYNOPSIS : fileptr=FilePart(path)
  221.               D0     -870    D1
  222.  
  223. NAME     : FindArg
  224. FUNCTION : find a keyword in a template
  225. SYNOPSIS : index=FindArg(template,keyword)
  226.              D0    -804     D1       D2
  227.  
  228. NAME     : FindCliProc
  229. FUNCTION : returns a pointer to the requested CLI process
  230. SYNOPSIS : proc=FindCliProc(num)
  231.             D0     -546      D1
  232.  
  233. NAME     : FindDosEntry
  234. FUNCTION : Finds a specific Dos List entry
  235. SYNOPSIS : newdlist=FindDosEntry(dlist,name,flags)
  236.               D0        -684       D1   D2    D3
  237.  
  238. NAME     : FindSegment
  239. FUNCTION : Finds a segment on the resident list
  240. SYNOPSIS : segment=FindSegment(name,start,system)
  241.               D0      -780      D1    D2    D3
  242.  
  243. NAME     : FindVar
  244. FUNCTION : Finds a local variable
  245. SYNOPSIS : var=FindVar(name,type)
  246.             D0   -918   D1   D2
  247.  
  248. NAME     : Flush
  249. FUNCTION : Flushes buffers for a buffered filehandle
  250. SYNOPSIS : success=Flush(fh)
  251.              D0     -360 D1
  252.  
  253. NAME     : Format
  254. FUNCTION : Causes a filesystem to initialize itself
  255. SYNOPSIS : success=Format(filesystem,volumename,dostype)
  256.              D0     -714      D1         D2       D3
  257.  
  258. NAME     : FPutC
  259. FUNCTION : Write a character to the specified output (buffered)
  260. SYNOPSIS : char=FPutC(fh,char)
  261.             D0   -312 D1  D2
  262.  
  263. NAME     : FPuts
  264. FUNCTION : Writes a string the the specified output (buffered)
  265. SYNOPSIS : error=FPuts(fh,str)
  266.              D0   -342 D1  D2
  267.  
  268. NAME     : FRead
  269. FUNCTION : Reads a number of blocks from an input (buffered)
  270. SYNOPSIS : count=FRead(fh,buf,blocklen,blocks)
  271.              D0   -324 D1  D2    D3      D4
  272.  
  273. NAME     : FreeArgs
  274. FUNCTION : Free allocated memory after ReadArgs()
  275. SYNOPSIS : FreeArgs(rdargs)
  276.              -858     D1
  277.  
  278. NAME     : FreeDeviceProc
  279. FUNCTION : Releases port returned by GetDeviceProc()
  280. SYNOPSIS : FreeDeviceProc(devproc)
  281.                -648         D1
  282.  
  283. NAME     : FreeDosEntry
  284. FUNCTION : Frees an entry created by MakeDosEntry
  285. SYNOPSIS : FreeDosEntry(dlist)
  286.                -702       D1
  287.  
  288. NAME     : FreeDosObject
  289. FUNCTION : Frees an object allocated by AllocDosObject()
  290. SYNOPSIS : FreeDosObject(type,ptr)
  291.                -234       D1   D2
  292.  
  293. NAME     : FWrite
  294. FUNCTION : Writes a number of blocks to an output (buffered)
  295. SYNOPSIS : count=FWrite(fh,buf,blocklen,blocks)
  296.              D0   -330  D1  D2    D3      D4
  297.  
  298. NAME     : GetArgStr
  299. FUNCTION : Returns the arguments for the process
  300. SYNOPSIS : ptr=GetArgStr()
  301.             D0   -534
  302.  
  303. NAME     : GetConsoleTask
  304. FUNCTION : Returns the default console for the process
  305. SYNOPSIS : port=GetConsoleTask()
  306.             D0       -510
  307.  
  308. NAME     : GetCurrentDirName
  309. FUNCTION : returns the current directory name
  310. SYNOPSIS : success=GetCurrentDirName(buf,len)
  311.              D0          -564         D1  D2
  312.  
  313. NAME     : GetDeviceProc
  314. FUNCTION : Finds a handler to send a message to
  315. SYNOPSIS : devproc=GetDeviceProc(name,devproc)
  316.               D0       -642       D1     D2
  317.  
  318. NAME     : GetFileSysTask
  319. FUNCTION : Returns the default filesystem for the process
  320. SYNOPSIS : port=GetFileSysTask()
  321.             D0      -522
  322.  
  323. NAME     : GetProgramDir
  324. FUNCTION : Returns a lock on the directory the program was loaded from
  325. SYNOPSIS : lock=GetProgramDir()
  326.             D0      -600
  327.  
  328. NAME     : GetProgramName
  329. FUNCTION : Returns the current program name
  330. SYNOPSIS : success=GetProgramName(buf,len)
  331.              D0         -576       D1  D2
  332.  
  333. NAME     : GetPrompt
  334. FUNCTION : Returns the prompt for the current process
  335. SYNOPSIS : success=GetPrompt(buf,len)
  336.              D0      -588     D1  D2
  337.  
  338. NAME     : GetVar
  339. FUNCTION : Returns the value of a local or global variable
  340. SYNOPSIS : len=GetVar(name,buffer,size,flags)
  341.             D0  -906   D1    D1    D3   D4
  342.  
  343. NAME     : Info
  344. FUNCTION : Returns information about the disk
  345. SYNOPSIS : success=Info(lock,parameterBlock)
  346.              D0    -114  D1       D2
  347.  
  348. NAME     : Inhibit
  349. FUNCTION : Inhibits access to a filesystem
  350. SYNOPSIS : success=Inhibit(filesystem,flag)
  351.              D0      -726      D1      D2
  352.  
  353. NAME     : Input
  354. FUNCTION : Identify the program's initial input file handle
  355. SYNOPSIS : file=Input()
  356.             D0   -54
  357.  
  358. NAME     : InternalLoadSeg
  359. FUNCTION : Low-level load routine
  360. SYNOPSIS : seglist=InternalLoadSeg(fh,table,functionarray,stack)
  361.               D0        -756       D0   A0       A1         A2
  362.  
  363. NAME     : InternalUnLoadSeg
  364. FUNCTION : Unloads a seglist loaded with InternalLoadSeg()
  365. SYNOPSIS : success=InternalUnLoadSeg(seglist,FreeFunc)
  366.              D0          -762          D1       A1
  367.  
  368. NAME     : IoErr
  369. FUNCTION : Return extra information from the system
  370. SYNOPSIS : error=IoErr()
  371.              D0   -132
  372.  
  373. NAME     : IsFileSystem
  374. FUNCTION : returns whether a Dos handler is a filesystem
  375. SYNOPSIS : result=IsFileSystem(name)
  376.              D0       -708      D1
  377.  
  378. NAME     : IsInteractive
  379. FUNCTION : Discover whether a file is interactive
  380. SYNOPSIS : status=IsInteractive(file)
  381.              D0       -216       D1
  382.  
  383. NAME     : LoadSeg
  384. FUNCTION : Scatterload a loadable file into memory
  385. SYNOPSIS : seglist=LoadSeg(name)
  386.               D0     -150   D1
  387.  
  388. NAME     : Lock
  389. FUNCTION : Lock a directory or file
  390. SYNOPSIS : lock=Lock(name,accessMode)
  391.             D0   -84  D1      D2
  392.  
  393. NAME     : LockDosList
  394. FUNCTION : Locks the specified Dos Lists for use
  395. SYNOPSIS : dlist=LockDosList(flags)
  396.              D0     -654       D1
  397.  
  398. NAME     : LockRecord
  399. FUNCTION : Locks a portion of a file
  400. SYNOPSIS : success=LockRecord(fh,offset,length,mode,timeout)
  401.               D0      -270    D1   D2     D3    D4     D5
  402.  
  403. NAME     : LockRecords
  404. FUNCTION : Lock a series of records
  405. SYNOPSIS : success=LockRecords(record_array,timeout)
  406.               D0      -276          D1         D2
  407.  
  408. NAME     : MakeDosEntry
  409. FUNCTION : Creates a DosList structure
  410. SYNOPSIS : newdlist=MakeDosEntry(name,type)
  411.               D0        -696      D1   D2
  412.  
  413. NAME     : MakeLink
  414. FUNCTION : Creates a filesystem link
  415. SYNOPSIS : success=MakeLink(name,dest,soft)
  416.               D0     -444    D1   D2   D3
  417.  
  418. NAME     : MatchEnd
  419. FUNCTION : Free storage allocated for MatchFirst()/MatchNext()
  420. SYNOPSIS : MatchEnd(AnchorPath)
  421.              -834       D1
  422.  
  423. NAME     : MatchFirst
  424. FUNCTION : Finds file that matches pattern
  425. SYNOPSIS : error=MatchFirst(pat,AnchorPath)
  426.              D0     -822     D1     D2
  427.  
  428. NAME     : MatchNext
  429. FUNCTION : Finds the next file or directory that matches pattern
  430. SYNOPSIS : error=MatchNext(AnchorPath)
  431.              D0    -828        D1
  432.  
  433. NAME     : MatchPattern
  434. FUNCTION : Checks for a pattern match with a string
  435. SYNOPSIS : match=MatchPattern(pat,str)
  436.              D0      -846      D1  D2
  437.  
  438. NAME     : MatchPatternNoCase
  439. FUNCTION : Checks for a pattern match with a string
  440. SYNOPSIS : match=MatchPatternNoCase(pat,str)
  441.              D0        -972          D1  D2
  442.  
  443. NAME     : MaxCli
  444. FUNCTION : returns the highest CLI process number possibly in use
  445. SYNOPSIS : number=MaxCli()
  446.              D0    -552
  447.  
  448. NAME     : NameFromFH
  449. FUNCTION : Get the name of an open filehandle
  450. SYNOPSIS : success=NameFromFH(fh,buffer,len)
  451.               D0      -408    D1   D2    D3
  452.  
  453. NAME     : NameFromLock
  454. FUNCTION : Returns the name of a locked object
  455. SYNOPSIS : success=NameFromLock(lock,buffer,len)
  456.               D0      -402       D1    D2    D3
  457.  
  458. NAME     : NewLoadSeg
  459. FUNCTION : Improved version of LoadSeg for stacksizes
  460. SYNOPSIS : seglist=NewLoadSeg(file,tags)
  461.               D0     -768      D1   D2
  462.  
  463. NAME     : NextDosEntry
  464. FUNCTION : Get the next Dos List entry
  465. SYNOPSIS : newdlist=NextDosEntry(dlist,flags)
  466.               D0        -690       D1    D2
  467.  
  468. NAME     : Open
  469. FUNCTION : Open a file for input or output
  470. SYNOPSIS : file=Open(name,accessMode)
  471.             D0   -30  D1      D2
  472.  
  473. NAME     : OpenFromLock
  474. FUNCTION : Opens a file you have a lock on
  475. SYNOPSIS : fh=OpenFromLock(lock)
  476.            D0     -378      D1
  477.  
  478. NAME     : Output
  479. FUNCTION : Identify the programs' initial output file handle
  480. SYNOPSIS : file=Output()
  481.             D0   -60
  482.  
  483. NAME     : ParentDir
  484. FUNCTION : Obtain the parent of a directory or file
  485. SYNOPSIS : newlock=ParentDir(lock)
  486.               D0     -210     D1
  487.  
  488. NAME     : ParentOfFH
  489. FUNCTION : returns a lock on the parent directory of a file
  490. SYNOPSIS : lock=ParentOfFH(fh)
  491.             D0     -384    D1
  492.  
  493. NAME     : ParsePattern
  494. FUNCTION : Create a tokenized string for MatchPattern()
  495. SYNOPSIS : IsWild=ParsePattern(Source,Dest,DestLength)
  496.              D0      -840        D1    D2      D3
  497.  
  498. NAME     : ParsePatternNoCase
  499. FUNCTION : Create a tokenized string for MatchPatternNoCase()
  500. SYNOPSIS : IsWild=ParsePatternNoCase(Source,Dest,DestLength)
  501.              D0         -966           D1    D2      D3
  502.  
  503. NAME     : PathPart
  504. FUNCTION : Returns a pointer to the end of the next-to-last
  505.            component of a path
  506. SYNOPSIS : fileptr=PathPart(path)
  507.              D0      -876    D1
  508.  
  509. NAME     : PrintFault
  510. FUNCTION : Returns the text associated with a DOS error code
  511. SYNOPSIS : success=PrintFault(code,header)
  512.               D0      -474     D1    D2
  513.  
  514. NAME     : PutStr
  515. FUNCTION : Writes a string the the default output (buffered)
  516. SYNOPSIS : error=PutStr(str)
  517.              D0   -948   D1
  518.  
  519. NAME     : Read
  520. FUNCTION : Read bytes of data from a file
  521. SYNOPSIS : actualLength=Read(file,buffer,length)
  522.                 D0       -42  D1    D2     D3
  523.  
  524. NAME     : ReadArgs
  525. FUNCTION : Parse the command line input
  526. SYNOPSIS : result=ReadArgs(template,array,rdargs)
  527.              D0     -798      D1      D2    D3
  528.  
  529. NAME     : ReadItem
  530. FUNCTION : reads a single argument/name from command line
  531. SYNOPSIS : value=ReadItem(buffer,maxchars,input)
  532.              D0    -810     D1      D2      D3
  533.  
  534. NAME     : ReadLink
  535. FUNCTION : Reads the path for a soft filesystem link
  536. SYNOPSIS : success=ReadLink(port,lock,path,buffer,size)
  537.               D0     -438    D1   D2   D3    D4    D5
  538.  
  539. NAME     : Relabel
  540. FUNCTION : Change the volume name of a volume
  541. SYNOPSIS : success=Relabel(volumename,name)
  542.               D0     -720      D1      D2
  543.  
  544. NAME     : RemAssignList
  545. FUNCTION : Remove an entry from a multi-dir assign
  546. SYNOPSIS : success=RemAssignList(name,lock)
  547.               D0        -636      D1   D2
  548.  
  549. NAME     : RemDosEntry
  550. FUNCTION : Removes a Dos List entry from it's list
  551. SYNOPSIS : success=RemDosEntry(dlist)
  552.               D0       -672      D1
  553.  
  554. NAME     : RemSegment
  555. FUNCTION : Removes a resident segment from the resident list
  556. SYNOPSIS : success=RemSegment(segment)
  557.               D0      -786      D1
  558.  
  559. NAME     : Rename
  560. FUNCTION : Rename a directory or file
  561. SYNOPSIS : success=Rename(oldName,newName)
  562.               D0     -78     D1      D2
  563.  
  564. NAME     : ReplyPkt
  565. FUNCTION : replies a packet to the person who sent it to you
  566. SYNOPSIS : ReplyPkt(packet,result1,result2)
  567.              -258     D1     D2      D3
  568.  
  569. NAME     : RunCommand
  570. FUNCTION : Runs a program using the current process
  571. SYNOPSIS : rc=RunCommand(seglist,stacksize,argptr,argsize)
  572.            D0    -504      D1        D2      D3     D4
  573.  
  574. NAME     : SameDevice
  575. FUNCTION : Are two locks are on partitions of the device?
  576. SYNOPSIS : same=SameDevice(lock1,lock2)
  577.             D0     -984      D1    D2
  578.  
  579. NAME     : SameLock
  580. FUNCTION : returns whether two locks are on the same object
  581. SYNOPSIS : value=SameLock(lock1,lock2)
  582.              D0    -420     D1    D2
  583.  
  584. NAME     : Seek
  585. FUNCTION : Set the current position for reading and writing
  586. SYNOPSIS : oldPosition=Seek(file,position,mode)
  587.                 D0      -66  D1     D2     D3
  588.  
  589. NAME     : SelectInput
  590. FUNCTION : Select a filehandle as the default input channel
  591. SYNOPSIS : old_fh=SelectInput(fh)
  592.              D0      -294     D1
  593.  
  594. NAME     : SelectOutput
  595. FUNCTION : Select a filehandle as the default output channel
  596. SYNOPSIS : old_fh=SelectOutput(fh)
  597.              D0      -300      D1
  598.  
  599. NAME     : SendPkt
  600. FUNCTION : Sends a packet to a handler
  601. SYNOPSIS : SendPkt(packet,port,replyport)
  602.              -246    D1    D2      D3
  603.  
  604. NAME     : SetArgStr
  605. FUNCTION : Sets the arguments for the current process
  606. SYNOPSIS : oldptr=SetArgStr(ptr)
  607.              D0      -540    D1
  608.  
  609. NAME     : SetComment
  610. FUNCTION : Change a files' comment string
  611. SYNOPSIS : success=SetComment(name,comment)
  612.               D0      -180     D1     D2
  613.  
  614. NAME     : SetConsoleTask
  615. FUNCTION : Sets the default console for the process
  616. SYNOPSIS : oldport=SetConsoleTask(port)
  617.              D0        -516        D1
  618.  
  619. NAME     : SetCurrentDirName
  620. FUNCTION : Sets the directory name for the process
  621. SYNOPSIS : success=SetCurrentDirName(name)
  622.               D0         -558         D1
  623.  
  624. NAME     : SetFileDate
  625. FUNCTION : Sets the modification date for a file or dir
  626. SYNOPSIS : success=SetFileDate(name,date)
  627.               D0      -396      D1   D2
  628.  
  629. NAME     : SetFileSize
  630. FUNCTION : Sets the size of a file
  631. SYNOPSIS : newsize=SetFileSize(fh,offset,mode)
  632.               D0      -456     D1   D2    D3
  633.  
  634. NAME     : SetFileSysTask
  635. FUNCTION : Sets the default filesystem for the process
  636. SYNOPSIS : oldport=SetFileSysTask(port)
  637.               D0        -528       D1
  638.  
  639. NAME     : SetIoErr
  640. FUNCTION : Sets the value returned by IoErr()
  641. SYNOPSIS : oldcode=SetIoErr(code)
  642.               D0     -462    D1
  643.  
  644. NAME     : SetMode
  645. FUNCTION : Set the current behavior of a handler
  646. SYNOPSIS : success=SetMode(fh,mode)
  647.               D0     -426  D1  D2
  648.  
  649. NAME     : SetOwner
  650. FUNCTION : Set owner information for a file or directory
  651. SYNOPSIS : success=SetOwner(name,owner_info)
  652.               D0     -996    D1      D2
  653.  
  654. NAME     : SetProgramDir
  655. FUNCTION : Sets the directory returned by GetProgramDir
  656. SYNOPSIS : oldlock=SetProgramDir(lock)
  657.               D0       -594       D1
  658.  
  659. NAME     : SetProgramName
  660. FUNCTION : Sets the name of the program being run
  661. SYNOPSIS : success=SetProgramName(name)
  662.               D0        -570       D1
  663.  
  664. NAME     : SetPrompt
  665. FUNCTION : Sets the CLI/shell prompt for the current process
  666. SYNOPSIS : success=SetPrompt(name)
  667.               D0     -582     D1
  668.  
  669. NAME     : SetProtection
  670. FUNCTION : Set protection for a file or directory
  671. SYNOPSIS : success=SetProtection(name,mask)
  672.               D0        -186      D1   D2
  673.  
  674. NAME     : SetVar
  675. FUNCTION : Sets a local or environment variable
  676. SYNOPSIS : success=SetVar(name,buffer,size,flags)
  677.               D0    -900   D1    D2    D3    D4
  678.  
  679. NAME     : SetVBuf
  680. FUNCTION : set buffering modes and size
  681. SYNOPSIS : error=SetVBuf(fh,buff,type,size)
  682.              D0    -366  D1  D2   D3   D4
  683.  
  684. NAME     : SplitName
  685. FUNCTION : splits out a component of a pathname into a buffer
  686. SYNOPSIS : newpos=SplitName(name,separator,buf,oldpos,size)
  687.              D0     -414     D1     D2      D3   D4    D5
  688.  
  689. NAME     : StartNotify
  690. FUNCTION : Starts notification on a file or directory
  691. SYNOPSIS : success=StartNotify(notifystructure)
  692.               D0      -888            D1
  693.  
  694. NAME     : StrToDate
  695. FUNCTION : Converts a string to a DateStamp
  696. SYNOPSIS : success=StrToDate(datetime)
  697.               D0      -750      D1
  698.  
  699. NAME     : StrToLong
  700. FUNCTION : string to long value (decimal)
  701. SYNOPSIS : characters=StrToLong(string,value)
  702.                D0        -816     D1     D2
  703.  
  704. NAME     : SystemTagList
  705. FUNCTION : Have a shell execute a command line
  706. SYNOPSIS : error=SystemTagList(command,tags)
  707.              D0      -606         D1    D2
  708.  
  709. NAME     : UnGetC
  710. FUNCTION : Makes a char available for reading again (buffered)
  711. SYNOPSIS : value=UnGetC(fh,character)
  712.              D0   -318  D1     D2
  713.  
  714. NAME     : UnLoadSeg
  715. FUNCTION : Unload a seglist previously loaded by LoadSeg()
  716. SYNOPSIS : success=UnLoadSeg(seglist)
  717.               D0     -156      D1
  718.  
  719. NAME     : UnLock
  720. FUNCTION : Unlock a directory or file
  721. SYNOPSIS : UnLock(lock)
  722.              -90   D1
  723.  
  724. NAME     : UnLockDosList
  725. FUNCTION : Unlocks the Dos List
  726. SYNOPSIS : UnLockDosList(flags)
  727.                 -660       D1
  728.  
  729. NAME     : UnLockRecord
  730. FUNCTION : Unlock a record
  731. SYNOPSIS : success=UnLockRecord(fh,offset,length)
  732.               D0       -282     D1   D2     D3
  733.  
  734. NAME     : UnLockRecords
  735. FUNCTION : Unlock a list of records
  736. SYNOPSIS : success=UnLockRecords(record_array)
  737.               D0        -288          D1
  738.  
  739. NAME     : VFPrintf
  740. FUNCTION : format and print a string to a file (buffered)
  741. SYNOPSIS : count=VFPrintf(fh,fmt,argv)
  742.              D0    -354   D1  D2  D3
  743.  
  744. NAME     : VFWritef
  745. FUNCTION : write a BCPL formatted string to a file (buffered)
  746. SYNOPSIS : count=VFWritef(fh,fmt,argv)
  747.              D0    -348   D1  D2  D3
  748.  
  749. NAME     : VPrintf
  750. FUNCTION : format and print string (buffered)
  751. SYNOPSIS : count=VPrintf(fmt,argv)
  752.              D0    -954   D1  D2
  753.  
  754. NAME     : WaitForChar
  755. FUNCTION : Determine if chars arrive within a time limit
  756. SYNOPSIS : status=WaitForChar(file,timeout)
  757.              D0      -204      D1     D2
  758.  
  759. NAME     : WaitPkt
  760. FUNCTION : Waits for a packet to arrive at your pr_MsgPort
  761. SYNOPSIS : packet=WaitPkt()
  762.              D0    -252
  763.  
  764. NAME     : Write
  765. FUNCTION : Write bytes of data to a file
  766. SYNOPSIS : returnedLength= Write(file,buffer,length)
  767.                  D0         -48      D1    D2     D3
  768.  
  769. NAME     : WriteChars
  770. FUNCTION : Writes bytes to the the default output (buffered)
  771. SYNOPSIS : count=WriteChars(buf,buflen)
  772.              D0     -942     D1   D2
  773.  
  774.